Skip to content

[pull] master from marmelab:master#39

Merged
pull[bot] merged 109 commits intoStars1233:masterfrom
marmelab:master
Jun 23, 2025
Merged

[pull] master from marmelab:master#39
pull[bot] merged 109 commits intoStars1233:masterfrom
marmelab:master

Conversation

@pull
Copy link
Copy Markdown

@pull pull bot commented Jun 23, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Replace the legacy Datagrid component with a new DataTable iterator throughout the codebase and documentation; introduce full Material-UI theming support for defaultProps and styleOverrides via useThemeProps and styled() in buttons, inputs, fields, and list components; enhance all action buttons (Delete, Edit, Show, List, BulkExport, BulkUpdate, etc.) to use resource-aware translations and allow label/confirmation customizations; extend the useUpdateMany hook to accept custom mutation middlewares; update tests and stories to cover theming, translations, and the DataTable migration.

New Features:

  • Rename <Datagrid> to <DataTable> across code, docs, and examples
  • Add theming hooks (useThemeProps) and styled wrappers to support defaultProps and styleOverrides in Material-UI theme for all major components
  • Enable resource-specific translation and custom label/confirmation content in action buttons via useResourceTranslation
  • Allow useUpdateMany to accept a getMutateWithMiddlewares option for injection of update middlewares

Enhancements:

  • Update component stories and tests to validate theming and new translation keys
  • Consolidate documentation examples and links to reference <DataTable> instead of <Datagrid>
  • Refactor tests to use updated label keys and support theming overrides

Documentation:

  • Migrate all docs to use <DataTable> iterator
  • Update translation sections to reference new keys for page titles and button labels
  • Add theming usage examples in component documentation

Tests:

  • Adjust existing tests to assert new resource-specific label keys and theming overrides in stories

djhi and others added 30 commits April 21, 2025 14:12
Co-authored-by: Jean-Baptiste Kaiser <jb@marmelab.com>
Co-authored-by: Jean-Baptiste Kaiser <jb@marmelab.com>
slax57 and others added 25 commits June 20, 2025 17:20
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
Co-authored-by: Gildas Garcia <1122076+djhi@users.noreply.github.com>
…able

[Doc] Change our `Datagrid` examples to `DataTable`
Allow resource specific translations for pages and buttons
@pull pull bot added the ⤵️ pull label Jun 23, 2025
@pull pull bot merged commit 67e6782 into Stars1233:master Jun 23, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Jun 23, 2025

Reviewer's Guide

This PR systematically replaces the legacy Datagrid component with the new DataTable iterator, enriches components with MUI theming support via styled and useThemeProps, enhances localization by introducing resource-specific label resolution, updates tests and stories to validate the new behaviours, and extends the useUpdateMany hook to support middleware injection.

File-Level Changes

Change Details Files
Replace Datagrid with DataTable across docs, examples, and code
  • Updated MD documentation and code examples to import and use DataTable instead of Datagrid
  • Rewrote JSX snippets and stories to use and <DataTable.Col>
  • Replaced Datagrid references in examples and sample apps
docs/**/*.md
examples/simple/src/**/*.tsx
packages/ra-ui-materialui/src/**/*
Add MUI theming & style override support
  • Wrapped components with useThemeProps for defaultProps theming
  • Created styled wrappers and PREFIX constants for styleOverrides
  • Declared MUI ComponentsPropsList and Components modules for overrides
packages/ra-ui-materialui/src/**/*.tsx
Enable resource-specific label translation in buttons/fields
  • Extracted labelProp and replaced fixed defaults with useResourceTranslation
  • Integrated useGetRecordRepresentation to build dynamic label options
  • Refactored button/field components to avoid double translation and support aria-label
packages/ra-ui-materialui/src/button/*.tsx
packages/ra-ui-materialui/src/field/*.tsx
Update tests and stories for labels and theming
  • Adjusted spec files to expect resource-based label keys
  • Added Themed stories and tests to verify theme overrides
  • Extended stories to demonstrate default vs resource-specific translations
packages/ra-ui-materialui/src/**/*.spec.tsx
packages/ra-ui-materialui/src/**/*.stories.tsx
Extend useUpdateMany with middleware support
  • Introduced getMutateWithMiddlewares option and stored mutateWithMiddlewares ref
  • Updated mutation logic to invoke middlewares when provided
  • Enhanced types to include middleware injection function
packages/ra-core/src/dataProvider/useUpdateMany.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@gitnotebooks
Copy link
Copy Markdown

gitnotebooks bot commented Jun 23, 2025

Review these changes at https://app.gitnotebooks.com/Stars1233/react-admin/pull/39

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jun 23, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Join our Discord community for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants